<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>execution::bulk_execute</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="execution__blocking_t__possibly_t/value.html" title="execution::blocking_t::possibly_t::value">
<link rel="next" href="execution__bulk_guarantee.html" title="execution::bulk_guarantee">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="execution__blocking_t__possibly_t/value.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="execution__bulk_guarantee.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.execution__bulk_execute"></a><a class="link" href="execution__bulk_execute.html" title="execution::bulk_execute">execution::bulk_execute</a>
</h3></div></div></div>
<p>
        <a class="indexterm" name="boost_asio.indexterm.execution__bulk_execute"></a>
      </p>
<p>
        A customisation point that creates a bulk sender.
      </p>
<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">unspecified</span> <span class="identifier">bulk_execute</span> <span class="special">=</span> <span class="identifier">unspecified</span><span class="special">;</span>
</pre>
<p>
        The name <code class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_execute</span></code> denotes a customisation point
        object. If <code class="computeroutput"><span class="identifier">is_convertible_v</span><span class="special">&lt;</span><span class="identifier">N</span><span class="special">,</span>
        <span class="identifier">size_t</span><span class="special">&gt;</span></code>
        is true, then the expression <code class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_execute</span><span class="special">(</span><span class="identifier">S</span><span class="special">,</span>
        <span class="identifier">F</span><span class="special">,</span> <span class="identifier">N</span><span class="special">)</span></code> for
        some subexpressions <code class="computeroutput"><span class="identifier">S</span></code>, <code class="computeroutput"><span class="identifier">F</span></code>, and <code class="computeroutput"><span class="identifier">N</span></code>
        is expression-equivalent to:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
            <code class="computeroutput"><span class="identifier">S</span><span class="special">.</span><span class="identifier">bulk_execute</span><span class="special">(</span><span class="identifier">F</span><span class="special">,</span> <span class="identifier">N</span><span class="special">)</span></code>,
            if that expression is valid. If the function selected does not execute
            <code class="computeroutput"><span class="identifier">N</span></code> invocations of the
            function object <code class="computeroutput"><span class="identifier">F</span></code> on
            the executor <code class="computeroutput"><span class="identifier">S</span></code> in bulk
            with forward progress guarantee <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">S</span><span class="special">,</span> <span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_guarantee</span><span class="special">)</span></code>, and the result of that function does
            not model <code class="computeroutput"><span class="identifier">sender</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">&gt;</span></code>,
            the program is ill-formed with no diagnostic required.
          </li>
<li class="listitem">
            Otherwise, <code class="computeroutput"><span class="identifier">bulk_execute</span><span class="special">(</span><span class="identifier">S</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">N</span><span class="special">)</span></code>, if that expression is valid, with overload
            resolution performed in a context that includes the declaration <code class="computeroutput"><span class="keyword">void</span> <span class="identifier">bulk_execute</span><span class="special">();</span></code> and that does not include a declaration
            of <code class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_execute</span></code>. If the function selected
            by overload resolution does not execute <code class="computeroutput"><span class="identifier">N</span></code>
            invocations of the function object <code class="computeroutput"><span class="identifier">F</span></code>
            on the executor <code class="computeroutput"><span class="identifier">S</span></code> in
            bulk with forward progress guarantee <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">E</span><span class="special">,</span> <span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_guarantee</span><span class="special">)</span></code>, and the result of that function does
            not model <code class="computeroutput"><span class="identifier">sender</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">&gt;</span></code>,
            the program is ill-formed with no diagnostic required.
          </li>
<li class="listitem">
            Otherwise, if the types <code class="computeroutput"><span class="identifier">F</span></code>
            and <code class="computeroutput"><span class="identifier">executor_index_t</span><span class="special">&lt;</span><span class="identifier">remove_cvref_t</span><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;&gt;</span></code> model <code class="computeroutput"><span class="identifier">invocable</span></code>
            and if <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">S</span><span class="special">,</span> <span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_guarantee</span><span class="special">)</span></code>
            equals <code class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_guarantee</span><span class="special">.</span><span class="identifier">unsequenced</span></code>, then
          </li>
<li class="listitem">
            Evaluates <code class="computeroutput"><span class="identifier">DECAY_COPY</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">forward</span><span class="special">&lt;</span><span class="keyword">decltype</span><span class="special">(</span><span class="identifier">F</span><span class="special">)&gt;(</span><span class="identifier">F</span><span class="special">))</span></code> on the calling thread to create a function
            object <code class="computeroutput"><span class="identifier">cf</span></code>. [Note: Additional
            copies of <code class="computeroutput"><span class="identifier">cf</span></code> may subsequently
            be created. --end note.]
          </li>
<li class="listitem">
            For each value of <code class="computeroutput"><span class="identifier">i</span></code> in
            <code class="computeroutput"><span class="identifier">N</span></code>, <code class="computeroutput"><span class="identifier">cf</span><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></code> (or copy of <code class="computeroutput"><span class="identifier">cf</span></code>))
            will be invoked at most once by an execution agent that is unique for
            each value of <code class="computeroutput"><span class="identifier">i</span></code>.
          </li>
<li class="listitem">
            May block pending completion of one or more invocations of <code class="computeroutput"><span class="identifier">cf</span></code>.
          </li>
<li class="listitem">
            Synchronizes with (C++Std [intro.multithread]) the invocations of <code class="computeroutput"><span class="identifier">cf</span></code>.
          </li>
<li class="listitem">
            Otherwise, <code class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span class="identifier">bulk_execute</span><span class="special">(</span><span class="identifier">S</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">N</span><span class="special">)</span></code> is ill-formed.
          </li>
</ul></div>
<h5>
<a name="boost_asio.reference.execution__bulk_execute.h0"></a>
        <span class="phrase"><a name="boost_asio.reference.execution__bulk_execute.requirements"></a></span><a class="link" href="execution__bulk_execute.html#boost_asio.reference.execution__bulk_execute.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/execution/bulk_execute.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio/execution.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="execution__blocking_t__possibly_t/value.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="execution__bulk_guarantee.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
